// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace Taimila.Entify
{

	/// <summary>
	/// MatchFilter can be used to filter entities from the result set by
	/// matching properties with specific pattern.
	/// </summary>
	public sealed class MatchFilter : IDataFilter
	{
		/// <summary>
		/// Create a new case sensitive MatchFilter with empty match string.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property. Match is done against the value of this property. <see cref="System.String"/>
		/// </param>
		public MatchFilter(string targetProperty)
		{
			this.targetProperty = targetProperty;
			this.MatchString = string.Empty;
			this.IsCaseSensitive = true;
		}
		
		/// <summary>
		/// Creates a new case sensitive MatchFilter for given property with given match string.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property. Match is done against the value of this property. <see cref="System.String"/>
		/// </param>
		/// <param name="matchString">
		/// String that is used as match criteria. Use * character as a wildcard. <see cref="System.String"/>
		/// </param>
		public MatchFilter(string targetProperty, string matchString) : this(targetProperty)
		{
			this.MatchString = matchString;
		}
		
		/// <summary>
		/// Creates a new MatchFilter for given property with given match string.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property. Match is done against the value of this property. <see cref="System.String"/>
		/// </param>
		/// <param name="matchString">
		/// String that is used as match criteria. Use * character as a wildcard. <see cref="System.String"/>
		/// </param>
		/// <param name="isCaseSensitive">
		/// Does filter require match to be case sensitive. <see cref="System.Boolean"/>
		/// </param>
		public MatchFilter(string targetProperty, string matchString, bool isCaseSensitive) : this(targetProperty, matchString)
		{
			this.IsCaseSensitive = isCaseSensitive;
		}
		
		/// <summary>
		/// Matching is done with the value of this property.
		/// Property name of the entity type.
		/// </summary>
		public string targetProperty
		{
			get;
			set;
		}
		
		/// <summary>
		/// Does filter require match to be case sensitive.
		/// </summary>
		public bool IsCaseSensitive
		{
			get;
			set;
		}
		
		/// <summary>
		/// String that is used as match criteria. Use * character as a wildcard.
		/// </summary>
		public string MatchString
		{
			get;
			set;
		}
	}
}
